feat(cli): add --info flag to extract lightweight JSON metadata#2205
Open
saitejabandaru-in wants to merge 1 commit into
Open
feat(cli): add --info flag to extract lightweight JSON metadata#2205saitejabandaru-in wants to merge 1 commit into
saitejabandaru-in wants to merge 1 commit into
Conversation
…ut full conversion
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves #2182.
This PR adds a lightweight
--infoflag (and a public API methodget_metadata()) that outputs structured JSON metadata (path, size, mime type, and detected converter) for a given file or stream without executing the full conversion pipeline.This is highly useful for triage, cost/duration estimation, and routing in AI agent pipelines, where agents want to know what a document is before committing to full, potentially expensive conversion paths.
Examples
$ markitdown --info example.docx { "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "detected_converter": "DocxConverter", "size_bytes": 135824, "path": "example.docx" }Changes
get_metadata(),get_metadata_local(), andget_metadata_stream()methods in theMarkItDownclass (_markitdown.py) to resolve and return metadata by querying theaccepts()method of registered converters.--infooption to the CLI (__main__.py) which triggersget_metadata()and outputs the results as JSON.test_module_misc.py(test_get_metadata()) andtest_cli_misc.py(test_info_flag()).test_cli_misc.pyto usesys.executableinstead of the hardcoded"python"command, ensuring they run correctly on systems (like macOS) that only havepython3on their PATH.